Class AsaServiceObjectGroupImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.AsaServiceObjectGroupImpl
All Implemented Interfaces:
IPCObject, AsaServiceObjectGroup

public class AsaServiceObjectGroupImpl extends IPCObjectImpl implements AsaServiceObjectGroup
Information provided by the PKI file:

    \class CAsaServiceObjectGroup
    
    \brief CAsaServiceObjectGroup is service type object-group class
    \example network().getDevice("Router0").getObjectManager()->getObjectByName("objectName")
    \\use castTo() function to cast CAsaObject to CAsaServiceObjectGroup
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • addServiceObjectPortNum

      public boolean addServiceObjectPortNum(String protocolString, String directionStr, String operatorString, int portNum)
      Information provided by the PKI file:
      
          \brief Add port setting to the service object-group
          service-object tcp [<destination | source > <eq | gt | lt | neq> <port>]
          
          \param protocolString, tcp/udp
          \param directionStr, destination/source
          \param operatorString, eq | gt | lt | neq
          \param portNum, port number
          
          \return bool, value is true if the service
          
              
      Specified by:
      addServiceObjectPortNum in interface AsaServiceObjectGroup
      Parameters:
      protocolString - Takes in a parameter of protocolString
      directionStr - Takes in a parameter of directionStr
      operatorString - Takes in a parameter of operatorString
      portNum - Takes in a parameter of portNum
      Returns:
      boolean Returns a boolean
    • addPortObjectPortNum

      public boolean addPortObjectPortNum(String operatorString, int portNum)
      Information provided by the PKI file:
      
          \brief Add port setting to the service object-group
          port-object eq <keyword>
          \param operatorString,  eq
          \param portNum,  port number
          
          \return bool, value is true if the add was successful, false if not.
          
              
      Specified by:
      addPortObjectPortNum in interface AsaServiceObjectGroup
      Parameters:
      operatorString - Takes in a parameter of operatorString
      portNum - Takes in a parameter of portNum
      Returns:
      boolean Returns a boolean
    • addPortObjectPortStr

      public boolean addPortObjectPortStr(String operatorString, String strPortNum)
      Information provided by the PKI file:
      
          \brief Add port setting to the service object-group
          port-object eq <keyword>
          \param operatorString,  eq
          \param strPortNum, protocol associate with the port number
          
          \return bool, value is true if the add was successful, false if not.
          
              
      Specified by:
      addPortObjectPortStr in interface AsaServiceObjectGroup
      Parameters:
      operatorString - Takes in a parameter of operatorString
      strPortNum - Takes in a parameter of strPortNum
      Returns:
      boolean Returns a boolean
    • removeServiceObjectPortNum

      public int removeServiceObjectPortNum(String protocolString, String directionStr, String operatorString, int portNum)
      Information provided by the PKI file:
      
          \brief Remove port setting to the service object-group
          service-object tcp [<destination | source > <eq | gt | lt | neq> <port>]
          
          \param protocolString - tcp/udp
          \param directionStr - destination/source
          \param operatorString - eq | gt | lt | neq
          \param portNum - port number
          
          \return int, value 0 -- successful, 1 -- ACL doesn't exist, 2 -- unable to remove.
          
              
      Specified by:
      removeServiceObjectPortNum in interface AsaServiceObjectGroup
      Parameters:
      protocolString - Takes in a parameter of protocolString
      directionStr - Takes in a parameter of directionStr
      operatorString - Takes in a parameter of operatorString
      portNum - Takes in a parameter of portNum
      Returns:
      int Returns a int
    • removePortObjectPortNum

      public int removePortObjectPortNum(String operatorString, int portNum)
      Information provided by the PKI file:
      
          \brief Remove port setting to the service object-group
          port-object eq <keyword>
          
          \param operatorString,  eq
          \param portNum,  port number
          
          \return int, value 0 -- successful, 1 -- ACL doesn't exist, 2 -- unable to remove.
          
              
      Specified by:
      removePortObjectPortNum in interface AsaServiceObjectGroup
      Parameters:
      operatorString - Takes in a parameter of operatorString
      portNum - Takes in a parameter of portNum
      Returns:
      int Returns a int
    • removePortObjectPortStr

      public int removePortObjectPortStr(String operatorString, String strPortNum)
      Information provided by the PKI file:
      
          \brief Remove port setting to the service object-group
          port-object eq <keyword>
          \param operatorString, eq
          \param strPortNum - protocol associate with the port number
          
          \return int, value 0 -- successful, 1 -- ACL doesn't exist, 2 -- unable to remove.
          
              
      Specified by:
      removePortObjectPortStr in interface AsaServiceObjectGroup
      Parameters:
      operatorString - Takes in a parameter of operatorString
      strPortNum - Takes in a parameter of strPortNum
      Returns:
      int Returns a int
    • addPortRange

      public boolean addPortRange(int startPortNum, int endPortNum)
      Information provided by the PKI file:
      
          \brief Add port setting to the service object-group
          port-object range <0-65535> <0-65535>
          \param startPortNum, start port number
          \param endPortNum, end port number
          
          \return bool, value is true if the port range could be added, false if not.
          
              
      Specified by:
      addPortRange in interface AsaServiceObjectGroup
      Parameters:
      startPortNum - Takes in a parameter of startPortNum
      endPortNum - Takes in a parameter of endPortNum
      Returns:
      boolean Returns a boolean
    • removePortRange

      public boolean removePortRange(int startPortNum, int endPortNum)
      Information provided by the PKI file:
      
          \brief Remove port setting to the service object-group
          port-object range <0-65535> <0-65535>
          \param startPortNum, start port number
          \param endPortNum, end port number
          
          \return bool, value is true if the port range could be removed, false if not.
          
              
      Specified by:
      removePortRange in interface AsaServiceObjectGroup
      Parameters:
      startPortNum - Takes in a parameter of startPortNum
      endPortNum - Takes in a parameter of endPortNum
      Returns:
      boolean Returns a boolean
    • addIcmp

      public void addIcmp(String icmpStr, boolean isIpv4)
      Information provided by the PKI file:
      
          \brief Add service type icmp
          service-object icmp/icmp6 [echo | echo-reply]
          
          \param icmpStr, echo/echo-reply
          \param isIpv4, true for ipv4 and false for ipv6
          
              
      Specified by:
      addIcmp in interface AsaServiceObjectGroup
      Parameters:
      icmpStr - Takes in a parameter of icmpStr
      isIpv4 - Takes in a parameter of isIpv4
    • removeIcmp

      public boolean removeIcmp(String icmpStr, boolean isIpv4)
      Information provided by the PKI file:
      
          \brief Remove service type icmp
          service-object icmp/icmp6 [echo | echo-reply]
          \param icmpStr, echo/echo-reply
          \param isIpv4, true for ipv4 and false for ipv6
          
          return bool, value is true if the removal was successful, false if not.
          
              
      Specified by:
      removeIcmp in interface AsaServiceObjectGroup
      Parameters:
      icmpStr - Takes in a parameter of icmpStr
      isIpv4 - Takes in a parameter of isIpv4
      Returns:
      boolean Returns a boolean
    • getAclStatementCount

      public int getAclStatementCount()
      Information provided by the PKI file:
      
          \brief Returns the number of acl statements generated by this object-group
          
          return int, value is the number of acl statements generated by this object-group.
          
              
      Specified by:
      getAclStatementCount in interface AsaServiceObjectGroup
      Returns:
      int Returns a int
    • getAclStatementAt

      public ACLStatement getAclStatementAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the acl statement at a specific index
          
          \param index, index to get the statment from.  Range (0, getAclStatementCount()).
          
          \return AclStatement, Acl state at the specified index, if it exists.
          
              
      Specified by:
      getAclStatementAt in interface AsaServiceObjectGroup
      Parameters:
      index - Takes in a parameter of index
      Returns:
      ACLStatement Returns a ACLStatement
    • getRunningConfig

      public List<String> getRunningConfig()
      Information provided by the PKI file:
      
          \brief Returns the string configuration of the object
          
          \return vector<string>, value is the string configurations of the object.
          
              
      Specified by:
      getRunningConfig in interface AsaServiceObjectGroup
      Returns:
      List<String> Returns a List<String>
    • supportedTcpPortNameToStr

      public String supportedTcpPortNameToStr(int portNum)
      Information provided by the PKI file:
      
          \brief Returns tcp protocol associate with the port number
          
          \param portNum, port number to find the associated tcp protocal for.
          
          \return string, value is the tcp protocol assoiated with the port number
          
              
      Specified by:
      supportedTcpPortNameToStr in interface AsaServiceObjectGroup
      Parameters:
      portNum - Takes in a parameter of portNum
      Returns:
      String Returns a String
    • supportedTcpPortNameToNum

      public int supportedTcpPortNameToNum(String strPortNum)
      Information provided by the PKI file:
      
          \brief Returns the port number based on protocol name
          
          \param strPortNum, protocol that associates with port number.
          
          \return int, value is port number based on protocol name.
          
              
      Specified by:
      supportedTcpPortNameToNum in interface AsaServiceObjectGroup
      Parameters:
      strPortNum - Takes in a parameter of strPortNum
      Returns:
      int Returns a int